home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / editor / auror300.zip / QUICKFUN.DOX < prev    next >
Text File  |  1996-07-17  |  41KB  |  951 lines
  1.  
  2.  
  3.   AML Function Quick Reference
  4.   ────────────────────────────
  5.   This Quick Reference lists all AML statements and functions and by
  6.   category, including builtin (A.exe), library (Lib.x), and extension
  7.   (Ext.aml) functions.
  8.  
  9.   To use the Quick Reference within a macro: move the cursor to a
  10.   function name or statement keyword and press <shift f1>. This Quick
  11.   Reference can be used in any text file, including the Language
  12.   Reference (Language.dox), and the Function Reference (Function.dox).
  13.  
  14.   To transfer to the full AML Function Reference: move the cursor to a
  15.   function name or statement keyword in this Quick Reference and press
  16.   <shift f2>. Note that most extension functions are not documented in
  17.   the Function Reference.
  18.  
  19.   ──────────────────────────────────────────────────────────────────────
  20.   Copyright (C) 1996 by nuText Systems.  All rights reserved worldwide.
  21.   No parts of this document may be copied in part or in whole, except as
  22.   provided in the License in the accompanying documentation.
  23.   ──────────────────────────────────────────────────────────────────────
  24.  
  25.  
  26.   Language Statements
  27.   ───────────────────
  28.  
  29.   statements:
  30.     break                      // exit loops
  31.     case when otherwise / end  // complex conditional statement
  32.     constant/const             // define a constant or constant function
  33.     databuf / end              // define or add to a data buffer
  34.     #exec / #endexec           // define compile-time constants/functions
  35.     event / end                // define an event-handling function
  36.     for to/downto step/by / end // indexed loop
  37.     forward                    // declare a function or object symbol
  38.     function / end             // define a function
  39.     #if #elseif #else / #end   // conditional compilation
  40.     if elseif else / end       // conditional statement
  41.     if?                        // short conditional statement
  42.     include                    // include a macro source file
  43.     key / end                  // define a key-handling function
  44.     keyword                    // define syntax highlighting keywords
  45.     loop times / end           // unconditional loop
  46.     menu item / end            // define a pull-down or popup menu
  47.     menubar item / end         // define a menu bar for a window
  48.     object                     // create object / change current object
  49.     ref                        // pass a variable by reference
  50.     repeat / until             // repeat-until conditional loop
  51.     return                     // return from a function or macro
  52.     variable/var               // declare a local or global variable
  53.     while do / end             // while conditional loop
  54.  
  55.  
  56.   Objects:
  57.   ───────
  58.  
  59.   statements:
  60.     object         // create an object or change the current object
  61.  
  62.   builtin functions:
  63.     createobject   // create an object
  64.     destroyobject  // destroy an object
  65.     destroyvar     // destroy a public object variable
  66.     function?      // test if a public function exists
  67.     getcurrobj     // get the current (executing) object
  68.     geteventobj    // get the current event object
  69.     inheritkeys    // enable/disable key inheritance
  70.     lookup         // get the value of an public object variable
  71.     object?        // test if an object exists
  72.     objtype?       // test object inheritance hierarchy
  73.     set            // change the value of a public object variable
  74.     seteventobj    // change the current event object
  75.     setfunction    // change the definition of a public function
  76.     setobjtype     // change the inheritance path of an object
  77.     settype        // change the inheritance path of the current object
  78.     variable?      // test if a public variable exists
  79.  
  80.  
  81.   Event Handling:
  82.   ──────────────
  83.  
  84.   builtin functions:
  85.     call           // dispatch an event in the current object
  86.     dispatch       // wait for and dispatch the next event
  87.     endprocess     // return from a recursive invocation of the editor
  88.     event?         // test if one or more events are in the event queue
  89.     getcurrobj     // get the current (executing) object
  90.     geteventcount  // get the number of real events
  91.     geteventobj    // get the current event object
  92.     pass           // call the current function in a parent object
  93.     passprev       // call the current function in a preempted object
  94.     process        // invoke the editor recursively
  95.     purgequeue     // remove all events from the event queue
  96.     queue          // add an event to the event queue
  97.     queueobject    // queue an event to a specific object
  98.     send           // dispatch an event in the current event object
  99.     sendobject     // dispatch an event to a specified object
  100.     seteventobj    // change the current event object
  101.     sizequeue      // change the event queue size
  102.  
  103.  
  104.   Macro Compilation and Execution:
  105.   ───────────────────────────────
  106.  
  107.   builtin functions:
  108.     compilemacro   // compile a macro source file
  109.     eval           // evaluate a string as macro source code
  110.     geterror       // returns error information
  111.     getcurrfile    // get the current filename being executed or compiled
  112.     loadobject     // load an object
  113.     resident       // force a macro to remain resident or terminate
  114.     runmacro       // execute a compiled macro
  115.     seterror       // generate a compiler error
  116.  
  117.   extension functions:
  118.     askcmacro      // prompt to compile a macro source file
  119.     askeval        // prompt to evaluate a macro expression
  120.     askrmacro      // prompt to run a compiled macro file
  121.     compilemacro2  // compile a macro source file (with messages)
  122.     recompile      // recompile the editor
  123.     runcfg         // run a macro in the Cfg\ subdirectory (w/prefix cfg)
  124.     runmacro2      // load, execute, and discard a compiled macro
  125.     savecfg        // save current config variables and recompile
  126.  
  127.  
  128.   Strings:
  129.   ───────
  130.  
  131.   builtin functions:
  132.     bin2hex        // convert binary strings to hex strings
  133.     bin2int        // convert a 1, 2, or 4-byte string to an integer
  134.     char           // convert integers to 1-byte strings
  135.     char2          // convert integers to 2-byte strings
  136.     char4          // convert integers to 4-byte strings
  137.     concat         // concatenate strings together
  138.     copystr        // duplicate a string one or more times
  139.     flipcase       // toggle the case of each character in a string
  140.     hex2bin        // convert hex strings to binary strings
  141.     icompare       // test strings for equality, ignoring case
  142.     joinstr        // combine strings into a 'multistring'
  143.     locase         // convert a string to lower case
  144.     parse          // parse substrings (or substring positions) into variables
  145.     pos            // search for a string within another string
  146.     poschar        // search for a character class in string
  147.     posnot         // search for ~character class in string
  148.     splitstr       // split a 'multistring' into substrings
  149.     sub            // replace a substring within another string
  150.     thousands      // convert a number to a thousands-separated string
  151.     upcase         // convert a string to upper case
  152.  
  153.  
  154.   Miscellaneous:
  155.   ─────────────
  156.  
  157.   builtin functions:
  158.     arg            // access function arguments
  159.     array          // create an array
  160.     array?         // test if an array exists
  161.     base           // convert a number to a string in a new base
  162.     beep           // beep the PC speaker
  163.     delay          // suspend execution of a macro
  164.     eval           // evaluate a string as macro source code
  165.     halt           // exit to Dos immediately
  166.     machine        // execute machine-level code
  167.     peek           // return a copy of a Dos memory area
  168.     poke           // modify a Dos memory area
  169.     rand           // generate a random number
  170.     system         // execute a Dos program
  171.  
  172.  
  173.   Buffers:
  174.   ───────
  175.  
  176.   statements:
  177.     databuf        // define or add to a data buffer
  178.  
  179.   builtin functions:
  180.     actualcol      // get the actual column for an apparent column
  181.     actualrow      // get the actual row over an apparent d